---

tinyxml.h

Go to the documentation of this file.

/*
www.sourceforge.net/projects/tinyxml
Original code (2.0 and earlier )copyright (c) 2000-2002 Lee Thomason (www.grinninglizard.com)

This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any
damages arising from the use of this software.

Permission is granted to anyone to use this software for any
purpose, including commercial applications, and to alter it and
redistribute it freely, subject to the following restrictions:

1. The origin of this software must not be misrepresented; you must
not claim that you wrote the original software. If you use this
software in a product, an acknowledgment in the product documentation
would be appreciated but is not required.

2. Altered source versions must be plainly marked as such, and
must not be misrepresented as being the original software.

3. This notice may not be removed or altered from any source
distribution.
*/

/*
In accordance with item 2 of the above license,
this file has been modified from the original version,
to provide a minimal pull-parse back-end that cuts
down on the memory footprint when doing read-only operations.
*/


#ifndef TINYXML_INCLUDED
#define TINYXML_INCLUDED

#ifdef _MSC_VER
#pragma warning( disable : 4530 )
#pragma warning( disable : 4786 )
#endif

#include <cctype>
#include <cstdio>
#include <cstdlib>
#include <cstring>
#include <cassert>
#include <deque>

// Help out windows:
#if defined( _DEBUG ) && !defined( DEBUG )
#define DEBUG
#endif

#if defined( DEBUG ) && defined( _MSC_VER )
#include <windows.h>
#define TIXML_LOG OutputDebugString
#else
#define TIXML_LOG printf
#endif

#ifdef TIXML_USE_STL
    #include <string>
    #include <iostream>
    //#include <ostream>
    #define TIXML_STRING    std::string
    #define TIXML_ISTREAM   std::istream
    #define TIXML_OSTREAM   std::ostream
#else
    #include "tinystr.h"
    #define TIXML_STRING    TiXmlString
    #define TIXML_OSTREAM   TiXmlOutStream
#endif

class TiPullXmlDocument;
class TiPullXmlElement;
class TiPullXmlComment;
class TiPullXmlUnknown;
class TiPullXmlAttribute;
class TiPullXmlText;
class TiPullXmlDeclaration;

class TiPullXmlParsingData;

/*  Internal structure for tracking location of items 
    in the XML file.
*/
struct TiPullXmlCursor
{
    TiPullXmlCursor()       { Clear(); }
    TiPullXmlCursor(int pos) : filepos(pos) { }
    void Clear()        { filepos = -1; }
    bool operator==(const TiPullXmlCursor& ref) const
    { return (filepos == ref.filepos); }

    int filepos;
};


// Only used by Attribute::Query functions
enum 
{ 
    TIXML_SUCCESS,
    TIXML_NO_ATTRIBUTE,
    TIXML_WRONG_TYPE
};

/** TiXmlBase is a base class for every class in TinyXml.
    It does little except to establish that TinyXml classes
    can be printed and provide some utility functions.

    In XML, the document and elements can contain
    other elements and other types of nodes.

    @verbatim
    A Document can contain: Element (container or leaf)
                            Comment (leaf)
                            Unknown (leaf)
                            Declaration( leaf )

    An Element can contain: Element (container or leaf)
                            Text    (leaf)
                            Attributes (not on tree)
                            Comment (leaf)
                            Unknown (leaf)

    A Decleration contains: Attributes (not on tree)
    @endverbatim
*/
class TiPullXmlBase
{
    friend class TiPullXmlNode;
    friend class TiPullXmlElement;
    friend class TiPullXmlDocument;

public:
    TiPullXmlBase()                             {}
    virtual ~TiPullXmlBase()                    {}

    struct ParsePosition
    {
        ParsePosition() : data(0), pos(0) { }
        ParsePosition(const char* data_, int pos_) : data(data_), pos(pos_) { }
        const char* data;
        TiPullXmlCursor pos;
    };

    /** All TinyXml classes can print themselves to a filestream.
        This is a formatted print, and will insert tabs and newlines.
        
        (For an unformatted stream, use the << operator.)
    */
    virtual void Print( FILE* cfile, int depth ) const = 0;

    /** The world does not agree on whether white space should be kept or
        not. In order to make everyone happy, these global, static functions
        are provided to set whether or not TinyXml will condense all white space
        into a single space or not. The default is to condense. Note changing this
        values is not thread safe.
    */
    static void SetCondenseWhiteSpace( bool condense )      { condenseWhiteSpace = condense; }

    /// Return the current white space setting.
    static bool IsWhiteSpaceCondensed()                     { return condenseWhiteSpace; }

protected:
    // See STL_STRING_BUG
    // Utility class to overcome a bug.
    class StringToBuffer
    {
      public:
        StringToBuffer( const TIXML_STRING& str );
        ~StringToBuffer();
        char* buffer;
    };

    inline static bool  IsWhiteSpace( int c )       { return ( isspace( c ) || c == '\n' || c == '\r' ); }

    virtual void StreamOut (TIXML_OSTREAM *) const = 0;

    #ifdef TIXML_USE_STL
        static bool StreamWhiteSpace( TIXML_ISTREAM * in, TIXML_STRING * tag );
        static bool StreamTo( TIXML_ISTREAM * in, int character, TIXML_STRING * tag );
    #endif

    /*  Reads an XML name into the string provided. Returns
        a pointer just past the last character of the name,
        or 0 if the function has an error.
    */
    static const char* ReadName( const char* p, TIXML_STRING* name );

    /*  Reads text. Returns a pointer past the given end tag.
        Wickedly complex options, but it keeps the (sensitive) code in one place.
    */
    static const char* ReadText(    const char* in,             // where to start
                                    TIXML_STRING* text,         // the string read
                                    bool ignoreWhiteSpace,      // whether to keep the white space
                                    const char* endTag,         // what ends this text
                                    bool ignoreCase );          // whether to ignore case in the end tag

    virtual bool Parse( ParsePosition in, const char* &out, bool throwaway ) = 0;

    // If an entity has been found, transform it into a character.
    static const char* GetEntity( const char* in, char* value );

    // Get a character, while interpreting entities.
    inline static const char* GetChar( const char* p, char* _value )
    {
        assert( p );
        if ( *p == '&' )
        {
            return GetEntity( p, _value );
        }
        else
        {
            *_value = *p;
            return p+1;
        }
    }

    // Puts a string to a stream, expanding entities as it goes.
    // Note this should not contian the '<', '>', etc, or they will be transformed into entities!
    static void PutString( const TIXML_STRING& str, TIXML_OSTREAM* out );

    static void PutString( const TIXML_STRING& str, TIXML_STRING* out );

    // Return true if the next characters in the stream are any of the endTag sequences.
    static bool StringEqual(    const char* p,
                                const char* endTag,
                                bool ignoreCase );


    enum
    {
        TIXML_NO_ERROR = 0,
        TIXML_ERROR,
        TIXML_ERROR_OPENING_FILE,
        TIXML_ERROR_OUT_OF_MEMORY,
        TIXML_ERROR_PARSING_ELEMENT,
        TIXML_ERROR_FAILED_TO_READ_ELEMENT_NAME,
        TIXML_ERROR_READING_ELEMENT_VALUE,
        TIXML_ERROR_READING_ATTRIBUTES,
        TIXML_ERROR_PARSING_EMPTY,
        TIXML_ERROR_READING_END_TAG,
        TIXML_ERROR_PARSING_UNKNOWN,
        TIXML_ERROR_PARSING_COMMENT,
        TIXML_ERROR_PARSING_DECLARATION,
        TIXML_ERROR_DOCUMENT_EMPTY,

        TIXML_ERROR_STRING_COUNT
    };
    static const char* errorString[ TIXML_ERROR_STRING_COUNT ];

    TiPullXmlCursor startPos;

private:
    struct Entity
    {
        const char*     str;
        unsigned int    strLength;
        char            chr;
    };
    enum
    {
        NUM_ENTITY = 5,
        MAX_ENTITY_LENGTH = 6

    };
    static Entity entity[ NUM_ENTITY ];
    static bool condenseWhiteSpace;
};


/** The parent class for everything in the Document Object Model.
    (Except for attributes).
    Nodes have siblings, a parent, and children. A node can be
    in a document, or stand on its own. The type of a TiXmlNode
    can be queried, and it can be cast to its more defined type.
*/
class TiPullXmlNode : public TiPullXmlBase
{
    friend class TiPullXmlDocument;
    friend class TiPullXmlElement;

public:
    #ifdef TIXML_USE_STL    

        /** An input stream operator, for every class. Tolerant of newlines and
            formatting, but doesn't expect them.
        */
        friend std::istream& operator >> (std::istream& in, TiPullXmlNode& base);

        /** An output stream operator, for every class. Note that this outputs
            without any newlines or formatting, as opposed to Print(), which
            includes tabs and new lines.

            The operator<< and operator>> are not completely symmetric. Writing
            a node to a stream is very well defined. You'll get a nice stream
            of output, without any extra whitespace or newlines.
            
            But reading is not as well defined. (As it always is.) If you create
            a TiXmlElement (for example) and read that from an input stream,
            the text needs to define an element or junk will result. This is
            true of all input streams, but it's worth keeping in mind.

            A TiXmlDocument will read nodes until it reads a root element, and
            all the children of that root element.
        */  
        friend std::ostream& operator<< (std::ostream& out, const TiPullXmlNode& base);

        /// Appends the XML node or attribute to a std::string.
        friend std::string& operator<< (std::string& out, const TiPullXmlNode& base );

    #else
        // Used internally, not part of the public API.
        friend TIXML_OSTREAM& operator<< (TIXML_OSTREAM& out, const TiPullXmlNode& base);
    #endif

    /** The types of XML nodes supported by TinyXml. (All the
            unsupported types are picked up by UNKNOWN.)
    */
    enum NodeType
    {
        DOCUMENT,
        ELEMENT,
        COMMENT,
        UNKNOWN,
        TEXT,
        DECLARATION,
        TYPECOUNT
    };

    virtual ~TiPullXmlNode();

    /** The meaning of 'value' changes for the specific type of
        TiPullXmlNode.
        @verbatim
        Document:   filename of the xml file
        Element:    name of the element
        Comment:    the comment text
        Unknown:    the tag contents
        Text:       the text string
        @endverbatim

        The subclasses will wrap this function.
    */
    const char * Value() const { return value.c_str (); }

    void SetValue(const char* val) {}
    #ifdef TIXML_USE_STL
    void SetValue(const std::string& _value) {}
    #endif

    TiPullXmlNode* LinkActiveChild(TiPullXmlNode* node);

    /// One step up the DOM.
    TiPullXmlNode* Parent() const                   { return parent; }

    TiPullXmlNode* FirstChild( );           ///< The first child of this node with the matching 'value'. Will be null if none found.

    TiPullXmlNode* FirstChild( const char * value, NodeType _type );            ///< The first child of this node with the matching 'value'. Will be null if none found.

    #ifdef TIXML_USE_STL
    TiPullXmlNode* FirstChild( const std::string& _value, NodeType _type )
    {   return FirstChild (_value.c_str(), _type);  }   ///< STL std::string form.
    #endif

    TiPullXmlNode* NextSibling( ) ;

    /// Navigate to a sibling node with the given 'value'.
    TiPullXmlNode* NextSibling( const char * _value, NodeType _type ) ;
    
    #ifdef TIXML_USE_STL
    TiPullXmlNode* NextSibling( const std::string& _value, NodeType _type ) 
    {   return NextSibling (_value.c_str(), _type); }   ///< STL std::string form.
    #endif

    /** Convenience function to get through elements.
        Calls NextSibling and ToElement. Will skip all non-Element
        nodes. Returns 0 if there is not another element.
    */
    TiPullXmlElement* NextSiblingElement( ) ;
    TiPullXmlElement* NextSiblingElement( const char * _value ) 
    { TiPullXmlNode* n = NextSibling(_value, ELEMENT); return n ? n->ToElement() : 0; }

    #ifdef TIXML_USE_STL
    TiPullXmlElement* NextSiblingElement( const std::string& _value) 
    {   return NextSiblingElement (_value.c_str ());    }   ///< STL std::string form.
    #endif

    /// Convenience function to get through elements.
    TiPullXmlElement* FirstChildElement( ) ;

    /// Convenience function to get through elements.
    TiPullXmlElement* FirstChildElement( const char * _value ) 
    { TiPullXmlNode* n = FirstChild(_value, ELEMENT); return n ? n->ToElement() : 0; }

    #ifdef TIXML_USE_STL
    TiPullXmlElement* FirstChildElement( const std::string& _value ) const
    {   return FirstChildElement (_value.c_str ()); }   ///< STL std::string form.
    #endif

    /** Query the type (as an enumerated value, above) of this node.
        The possible types are: DOCUMENT, ELEMENT, COMMENT,
                                UNKNOWN, TEXT, and DECLARATION.
    */
    virtual NodeType Type() const   { return type; }

    bool hasChildren() const { return (endPosOpen.filepos >= 0); }

    /** Return a pointer to the Document this node lives in.
        Returns null if not in a document.
    */
    TiPullXmlDocument* GetDocument() const;

    TiPullXmlDocument* ToDocument()const        { return ( this && type == DOCUMENT ) ? (TiPullXmlDocument*) this : 0; } ///< Cast to a more defined type. Will return null not of the requested type.
    TiPullXmlElement*  ToElement() const        { return ( this && type == ELEMENT  ) ? (TiPullXmlElement*)  this : 0; } ///< Cast to a more defined type. Will return null not of the requested type.
    TiPullXmlComment*  ToComment() const        { return ( this && type == COMMENT  ) ? (TiPullXmlComment*)  this : 0; } ///< Cast to a more defined type. Will return null not of the requested type.
    TiPullXmlUnknown*  ToUnknown() const        { return ( this && type == UNKNOWN  ) ? (TiPullXmlUnknown*)  this : 0; } ///< Cast to a more defined type. Will return null not of the requested type.
    TiPullXmlText*     ToText()     const       { return ( this && type == TEXT     ) ? (TiPullXmlText*)     this : 0; } ///< Cast to a more defined type. Will return null not of the requested type.
    TiPullXmlDeclaration* ToDeclaration()const  { return ( this && type == DECLARATION ) ? (TiPullXmlDeclaration*) this : 0; } ///< Cast to a more defined type. Will return null not of the requested type.

    /** Return the position, in the original source file, of this node or attribute.
        The row and column are 1-based. (That is the first row and first column is
        1,1). If the returns values are 0 or less, then the parser does not have
        a row and column value.

        Generally, the row and column value will be set when the TiXmlDocument::Load(),
        TiXmlDocument::LoadFile(), or any TiXmlNode::Parse() is called. It will NOT be set
        when the DOM was created from operator>>.

        The values reflect the initial load. Once the DOM is modified programmatically
        (by adding or changing nodes and attributes) the new values will NOT update to
        reflect changes in the document.

        There is a minor performance cost to computing the row and column. Computation
        can be disabled if TiXmlDocument::SetTabSize() is called with 0 as the value.

        @sa TiXmlDocument::SetTabSize()
    */
    int Row() const;
    int Column() const;

protected:
    TiPullXmlNode( NodeType type );

    #ifdef TIXML_USE_STL
        // The real work of the input operator.
        virtual void StreamIn( TIXML_ISTREAM* in, TIXML_STRING* tag ) = 0;
    #endif

    // Figure out what is at *p, and parse it. Returns null if it is not an xml node.
    TiPullXmlNode* Identify( const char* start ) const;

    bool FindElementClose(ParsePosition in, const char* &out);

    // Internal Value function returning a TIXML_STRING
    TIXML_STRING SValue() const { return value ; }

    TiPullXmlNode*      parent;
    TiPullXmlNode*      activeChild;
    NodeType const      type;

    TiPullXmlCursor     endPosOpen;
    TiPullXmlCursor     endPosClose;

    TIXML_STRING        value;
};


/** An attribute is a name-value pair. Elements have an arbitrary
    number of attributes, each with a unique name.

    @note The attributes are not TiXmlNodes, since they are not
          part of the tinyXML document object model. There are other
          suggested ways to look at this problem.
*/
class TiPullXmlAttribute : public TiPullXmlBase
{
    friend class TiPullXmlAttributeSet;

public:
    /// Construct an empty attribute.
    TiPullXmlAttribute()
    {
        document = 0;
        prev = next = 0;
    }

    #ifdef TIXML_USE_STL
    /// std::string constructor.
    TiPullXmlAttribute( const std::string& _name, const std::string& _value )
    {
        name = _name;
        value = _value;
        document = 0;
        prev = next = 0;
    }
    #endif

    /// Construct an attribute with a name and value.
    TiPullXmlAttribute( const char * _name, const char * _value )
    {
        name = _name;
        value = _value;
        document = 0;
        prev = next = 0;
    }

    const char*     Name()  const       { return name.c_str (); }       ///< Return the name of this attribute.
    const char*     Value() const       { return value.c_str (); }      ///< Return the value of this attribute.
    const int       IntValue() const;                                   ///< Return the value of this attribute, converted to an integer.
    const double    DoubleValue() const;                                ///< Return the value of this attribute, converted to a double.

    /** QueryIntValue examines the value string. It is an alternative to the
        IntValue() method with richer error checking.
        If the value is an integer, it is stored in 'value' and 
        the call returns TIXML_SUCCESS. If it is not
        an integer, it returns TIXML_WRONG_TYPE.

        A specialized but useful call. Note that for success it returns 0,
        which is the opposite of almost all other TinyXml calls.
    */
    int QueryIntValue( int* value ) const;
    /// QueryDoubleValue examines the value string. See QueryIntValue().
    int QueryDoubleValue( double* value ) const;

    void SetName( const char* _name )   { name = _name; }               ///< Set the name of this attribute.
    void SetValue( const char* _value ) { value = _value; }             ///< Set the value.

    void SetIntValue( int value );                                      ///< Set the value from an integer.
    void SetDoubleValue( double value );                                ///< Set the value from a double.

    #ifdef TIXML_USE_STL
    /// STL std::string form.
    void SetName( const std::string& _name )    
    {   
        StringToBuffer buf( _name );
        SetName ( buf.buffer ? buf.buffer : "error" );  
    }
    /// STL std::string form.   
    void SetValue( const std::string& _value )  
    {   
        StringToBuffer buf( _value );
        SetValue( buf.buffer ? buf.buffer : "error" );  
    }
    #endif

    /// Get the next sibling attribute in the DOM. Returns null at end.
    TiPullXmlAttribute* Next() const;
    /// Get the previous sibling attribute in the DOM. Returns null at beginning.
    TiPullXmlAttribute* Previous() const;

    bool operator==( const TiPullXmlAttribute& rhs ) const { return rhs.name == name; }
    bool operator<( const TiPullXmlAttribute& rhs )  const { return name < rhs.name; }
    bool operator>( const TiPullXmlAttribute& rhs )  const { return name > rhs.name; }

    /*  [internal use]
        Attribtue parsing starts: first letter of the name
                         returns: the next char after the value end quote
    */
    virtual bool Parse( ParsePosition in, const char* &out, bool throwaway );

    // [internal use]
    virtual void Print( FILE* cfile, int depth ) const;

    virtual void StreamOut( TIXML_OSTREAM * out ) const;
    // [internal use]
    // Set the document pointer so the attribute can report errors.
    void SetDocument( TiPullXmlDocument* doc )  { document = doc; }

private:
    TiPullXmlDocument*  document;   // A pointer back to a document, for error reporting.
    TIXML_STRING name;
    TIXML_STRING value;
    TiPullXmlAttribute* prev;
    TiPullXmlAttribute* next;
};


/*  A class used to manage a group of attributes.
    It is only used internally, both by the ELEMENT and the DECLARATION.
    
    The set can be changed transparent to the Element and Declaration
    classes that use it, but NOT transparent to the Attribute
    which has to implement a next() and previous() method. Which makes
    it a bit problematic and prevents the use of STL.

    This version is implemented with circular lists because:
        - I like circular lists
        - it demonstrates some independence from the (typical) doubly linked list.
*/
class TiPullXmlAttributeSet
{
public:
    TiPullXmlAttributeSet();
    ~TiPullXmlAttributeSet();

    void Add( TiPullXmlAttribute* attribute );
    void Remove( TiPullXmlAttribute* attribute );

    TiPullXmlAttribute* First() const   { return ( sentinel.next == &sentinel ) ? 0 : sentinel.next; }
    TiPullXmlAttribute* Last()  const   { return ( sentinel.prev == &sentinel ) ? 0 : sentinel.prev; }
    TiPullXmlAttribute* Find( const char * name ) const;

private:
    TiPullXmlAttribute sentinel;
};


/** The element is a container class. It has a value, the element name,
    and can contain other elements, text, comments, and unknowns.
    Elements also contain an arbitrary number of attributes.
*/
class TiPullXmlElement : public TiPullXmlNode
{
public:
    /// Construct an element.
    TiPullXmlElement (const char * in_value);

    #ifdef TIXML_USE_STL
    /// std::string constructor.
    TiPullXmlElement( const std::string& _value ) :     TiPullXmlNode( TiPullXmlNode::ELEMENT )
    {
        firstChild = lastChild = 0;
        value = _value;
    }
    #endif

    virtual ~TiPullXmlElement();

    /** Given an attribute name, Attribute() returns the value
        for the attribute of that name, or null if none exists.
    */
    const char* Attribute( const char* name ) const;

    /** Given an attribute name, Attribute() returns the value
        for the attribute of that name, or null if none exists.
        If the attribute exists and can be converted to an integer,
        the integer value will be put in the return 'i', if 'i'
        is non-null.
    */
    const char* Attribute( const char* name, int* i ) const;

    /** Given an attribute name, Attribute() returns the value
        for the attribute of that name, or null if none exists.
        If the attribute exists and can be converted to an double,
        the double value will be put in the return 'd', if 'd'
        is non-null.
    */
    const char* Attribute( const char* name, double* d ) const;

    /** QueryIntAttribute examines the attribute - it is an alternative to the
        Attribute() method with richer error checking.
        If the attribute is an integer, it is stored in 'value' and 
        the call returns TIXML_SUCCESS. If it is not
        an integer, it returns TIXML_WRONG_TYPE. If the attribute
        does not exist, then TIXML_NO_ATTRIBUTE is returned.
    */  
    int QueryIntAttribute( const char* name, int* value ) const;
    /// QueryDoubleAttribute examines the attribute - see QueryIntAttribute().
    int QueryDoubleAttribute( const char* name, double* value ) const;

    #ifdef TIXML_USE_STL
    const char* Attribute( const std::string& name ) const              { return Attribute( name.c_str() ); }
    const char* Attribute( const std::string& name, int* i ) const      { return Attribute( name.c_str(), i ); }
    #endif

    TiPullXmlAttribute* FirstAttribute() const  { return attributeSet.First(); }        ///< Access the first attribute in this element.
    TiPullXmlAttribute* LastAttribute() const   { return attributeSet.Last(); }     ///< Access the last attribute in this element.

    // [internal use]

    virtual void Print( FILE* cfile, int depth ) const;

protected:

    // Used to be public [internal use]
    #ifdef TIXML_USE_STL
        virtual void StreamIn( TIXML_ISTREAM * in, TIXML_STRING * tag );
    #endif
    virtual void StreamOut( TIXML_OSTREAM * out ) const;

    /*  [internal use]
        Attribtue parsing starts: next char past '<'
                         returns: next char past '>'
    */
    virtual bool Parse( ParsePosition in, const char* &out, bool throwaway );

private:
    TiPullXmlAttributeSet attributeSet;
};


/** An XML comment.
*/
class TiPullXmlComment : public TiPullXmlNode
{
public:
    /// Constructs an empty comment.
    TiPullXmlComment() : TiPullXmlNode( TiPullXmlNode::COMMENT ) {}
    virtual ~TiPullXmlComment() {}

    // [internal use]
    virtual void Print( FILE* cfile, int depth ) const;
protected:
    // used to be public
    #ifdef TIXML_USE_STL
        virtual void StreamIn( TIXML_ISTREAM * in, TIXML_STRING * tag );
    #endif
    virtual void StreamOut( TIXML_OSTREAM * out ) const;
    /*  [internal use]
        Attribtue parsing starts: at the ! of the !--
                         returns: next char past '>'
    */
    virtual bool Parse( ParsePosition in, const char* &out, bool throwaway );
};


/** XML text. Contained in an element.
*/
class TiPullXmlText : public TiPullXmlNode
{
    friend class TiPullXmlElement;
public:
    TiPullXmlText( ) : TiPullXmlNode (TiPullXmlNode::TEXT)
    { }
    /// Constructor.
    TiPullXmlText (const char * initValue) : TiPullXmlNode (TiPullXmlNode::TEXT)
    { SetValue( initValue ); }
    virtual ~TiPullXmlText() {}

    #ifdef TIXML_USE_STL
    /// Constructor.
    TiPullXmlText( const std::string& initValue ) : TiPullXmlNode (TiPullXmlNode::TEXT)
    { SetValue( initValue ); }
    #endif

    // [internal use]
    virtual void Print( FILE* cfile, int depth ) const;

protected :
    virtual void StreamOut ( TIXML_OSTREAM * out ) const;
    // [internal use]
    bool Blank() const; // returns true if all white space and new lines
    /*  [internal use]
            Attribtue parsing starts: First char of the text
                             returns: next char past '>'
    */
    virtual bool Parse( ParsePosition in, const char* &out, bool throwaway );
    // [internal use]
    #ifdef TIXML_USE_STL
        virtual void StreamIn( TIXML_ISTREAM * in, TIXML_STRING * tag );
    #endif
};


/** In correct XML the declaration is the first entry in the file.
    @verbatim
        <?xml version="1.0" standalone="yes"?>
    @endverbatim

    TinyXml will happily read or write files without a declaration,
    however. There are 3 possible attributes to the declaration:
    version, encoding, and standalone.

    Note: In this version of the code, the attributes are
    handled as special cases, not generic attributes, simply
    because there can only be at most 3 and they are always the same.
*/
class TiPullXmlDeclaration : public TiPullXmlNode
{
public:
    /// Construct an empty declaration.
    TiPullXmlDeclaration()   : TiPullXmlNode( TiPullXmlNode::DECLARATION ) {}

#ifdef TIXML_USE_STL
    /// Constructor.
    TiPullXmlDeclaration(   const std::string& _version,
                        const std::string& _encoding,
                        const std::string& _standalone )
            : TiPullXmlNode( TiPullXmlNode::DECLARATION )
    {
        version = _version;
        encoding = _encoding;
        standalone = _standalone;
    }
#endif

    /// Construct.
    TiPullXmlDeclaration(   const char* _version,
                        const char* _encoding,
                        const char* _standalone );

    virtual ~TiPullXmlDeclaration() {}

    /// Version. Will return empty if none was found.
    const char * Version() const        { return version.c_str (); }
    /// Encoding. Will return empty if none was found.
    const char * Encoding() const       { return encoding.c_str (); }
    /// Is this a standalone document?
    const char * Standalone() const     { return standalone.c_str (); }

    // [internal use]
    virtual void Print( FILE* cfile, int depth ) const;

protected:
    // used to be public
    #ifdef TIXML_USE_STL
        virtual void StreamIn( TIXML_ISTREAM * in, TIXML_STRING * tag );
    #endif
    virtual void StreamOut ( TIXML_OSTREAM * out) const;
    //  [internal use]
    //  Attribtue parsing starts: next char past '<'
    //                   returns: next char past '>'

    virtual bool Parse( ParsePosition in, const char* &out, bool throwaway );

private:
    TIXML_STRING version;
    TIXML_STRING encoding;
    TIXML_STRING standalone;
};


/** Any tag that tinyXml doesn't recognize is saved as an
    unknown. It is a tag of text, but should not be modified.
    It will be written back to the XML, unchanged, when the file
    is saved.
*/
class TiPullXmlUnknown : public TiPullXmlNode
{
public:
    TiPullXmlUnknown() : TiPullXmlNode( TiPullXmlNode::UNKNOWN ) {}
    virtual ~TiPullXmlUnknown() {}

    // [internal use]
    virtual void Print( FILE* cfile, int depth ) const;
protected:
    #ifdef TIXML_USE_STL
        virtual void StreamIn( TIXML_ISTREAM * in, TIXML_STRING * tag );
    #endif
    virtual void StreamOut ( TIXML_OSTREAM * out ) const;
    /*  [internal use]
        Attribute parsing starts: First char of the text
                         returns: next char past '>'
    */
    virtual bool Parse( ParsePosition in, const char* &out, bool throwaway );
};


/** Always the top level node. A document binds together all the
    XML pieces. It can be saved, loaded, and printed to the screen.
    The 'value' of a document node is the xml file name.
*/
class TiPullXmlDocument : public TiPullXmlNode
{
    friend class TiPullXmlNode;
public:
    /// Create an empty document, that has no name.
    TiPullXmlDocument();
    /// Create a document with a name. The name of the document is also the filename of the xml.
    TiPullXmlDocument( const char * documentName );

    #ifdef TIXML_USE_STL
    /// Constructor.
    TiPullXmlDocument( const std::string& documentName ) :
        TiPullXmlNode( TiPullXmlNode::DOCUMENT )
    {
        value = documentName;
        error = false;
    }
    #endif

    virtual ~TiPullXmlDocument() {}

    /** Load a file using the current document value.
        Returns true if successful. Will delete any existing
        document data before loading.
    */
    bool LoadFile();
    /// Save a file using the current document value. Returns true if successful.
    bool SaveFile() const;
    /// Load a file using the given filename. Returns true if successful.
    bool LoadFile( const char * filename );
    /// Save a file using the given filename. Returns true if successful.
    bool SaveFile( const char * filename ) const;

    #ifdef TIXML_USE_STL
    bool LoadFile( const std::string& filename )            ///< STL std::string version.
    {
        StringToBuffer f( filename );
        return ( f.buffer && LoadFile( f.buffer ));
    }
    bool SaveFile( const std::string& filename ) const      ///< STL std::string version.
    {
        StringToBuffer f( filename );
        return ( f.buffer && SaveFile( f.buffer ));
    }
    #endif

    /** Parse the given null terminated block of xml data.
    */
    virtual bool Parse( ParsePosition in, const char* &out, bool throwaway );

    /** Get the root element -- the only top level element -- of the document.
        In well formed XML, there should only be one. TinyXml is tolerant of
        multiple elements at the document level.
    */
    TiPullXmlElement* RootElement()         { return FirstChildElement(); }

    /** If an error occurs, Error will be set to true. Also,
        - The ErrorId() will contain the integer identifier of the error (not generally useful)
        - The ErrorDesc() method will return the name of the error. (very useful)
        - The ErrorRow() and ErrorCol() will return the location of the error (if known)
    */  
    bool Error() const                      { return error; }

    /// Contains a textual (english) description of the error if one occurs.
    const char * ErrorDesc() const  { return errorDesc.c_str (); }

    /** Generally, you probably want the error string ( ErrorDesc() ). But if you
        prefer the ErrorId, this function will fetch it.
    */
    const int ErrorId() const               { return errorId; }

    /** Returns the location (if known) of the error. The first column is column 1, 
        and the first row is row 1. A value of 0 means the row and column wasn't applicable
        (memory errors, for example, have no row/column) or the parser lost the error. (An
        error in the error reporting, in that case.)

        @sa SetTabSize, Row, Column
    */
    int ErrorRow() const;
    int ErrorCol() const;

    /** By calling this method, with a tab size
        greater than 0, the row and column of each node and attribute is stored
        when the file is loaded. Very useful for tracking the DOM back in to
        the source file.

        The tab size is required for calculating the location of nodes. If not
        set, the default of 4 is used. The tabsize is set per document. Setting
        the tabsize to 0 disables row/column tracking.

        Note that row and column tracking is not supported when using operator>>.

        The tab size needs to be enabled before the parse or load. Correct usage:
        @verbatim
        TiPullXmlDocument doc;
        doc.SetTabSize( 8 );
        doc.Load( "myfile.xml" );
        @endverbatim

        @sa Row, Column
    */
    void SetTabSize( int _tabsize )     { tabsize = _tabsize; }

    int TabSize() const { return tabsize; }

    /** If you have handled the error, it can be reset with this call. The error
        state is automatically cleared if you Parse a new XML block.
    */
    void ClearError()                       {   error = false; 
                                                errorId = 0; 
                                                errorDesc = ""; 
                                                errorLocation.Clear(); 
                                                //errorLocation.last = 0; 
                                            }

    /** Dump the document to standard out. */
    void Print() const                      { Print( stdout, 0 ); }

    // [internal use]
    virtual void Print( FILE* cfile, int depth = 0 ) const;
    // [internal use]
    void SetError( int err, const char* errorLocation, TiPullXmlParsingData* prevData );

    const char* getFileBuffer() const { return fileBuffer; }
    void setFileBuffer(const char* buf) { fileBuffer = buf; }

protected :
    virtual void StreamOut ( TIXML_OSTREAM * out) const;
    #ifdef TIXML_USE_STL
        virtual void StreamIn( TIXML_ISTREAM * in, TIXML_STRING * tag );
    #endif

    void FindAllLineStarts( const char* p );
    int FindLine(TiPullXmlCursor location) const;

private:
    bool error;
    int  errorId;
    TIXML_STRING errorDesc;
    int tabsize;
    TiPullXmlCursor errorLocation;
    std::deque<int> lineStarts;
    const char* fileBuffer;
};


/**
    A TiXmlHandle is a class that wraps a node pointer with null checks; this is
    an incredibly useful thing. Note that TiXmlHandle is not part of the TinyXml
    DOM structure. It is a separate utility class.

    Take an example:
    @verbatim
    <Document>
        <Element attributeA = "valueA">
            <Child attributeB = "value1" />
            <Child attributeB = "value2" />
        </Element>
    <Document>
    @endverbatim

    Assuming you want the value of "attributeB" in the 2nd "Child" element, it's very 
    easy to write a *lot* of code that looks like:

    @verbatim
    TiXmlElement* root = document.FirstChildElement( "Document" );
    if ( root )
    {
        TiXmlElement* element = root->FirstChildElement( "Element" );
        if ( element )
        {
            TiXmlElement* child = element->FirstChildElement( "Child" );
            if ( child )
            {
                TiXmlElement* child2 = child->NextSiblingElement( "Child" );
                if ( child2 )
                {
                    // Finally do something useful.
    @endverbatim

    And that doesn't even cover "else" cases. TiXmlHandle addresses the verbosity
    of such code. A TiXmlHandle checks for null pointers so it is perfectly safe 
    and correct to use:

    @verbatim
    TiXmlHandle docHandle( &document );
    TiXmlElement* child2 = docHandle.FirstChild( "Document" ).FirstChild( "Element" ).Child( "Child", 1 ).Element();
    if ( child2 )
    {
        // do something useful
    @endverbatim

    Which is MUCH more concise and useful.

    It is also safe to copy handles - internally they are nothing more than node pointers.
    @verbatim
    TiXmlHandle handleCopy = handle;
    @endverbatim

    What they should not be used for is iteration:

    @verbatim
    int i=0; 
    while ( true )
    {
        TiXmlElement* child = docHandle.FirstChild( "Document" ).FirstChild( "Element" ).Child( "Child", i ).Element();
        if ( !child )
            break;
        // do something
        ++i;
    }
    @endverbatim

    It seems reasonable, but it is in fact two embedded while loops. The Child method is 
    a linear walk to find the element, so this code would iterate much more than it needs 
    to. Instead, prefer:

    @verbatim
    TiXmlElement* child = docHandle.FirstChild( "Document" ).FirstChild( "Element" ).FirstChild( "Child" ).Element();

    for( child; child; child=child->NextSiblingElement() )
    {
        // do something
    }
    @endverbatim
*/
class TiPullXmlHandle
{
public:
    /// Create a handle from any node (at any depth of the tree.) This can be a null pointer.
    TiPullXmlHandle( TiPullXmlNode* node )          { this->node = node; }
    /// Copy constructor
    TiPullXmlHandle( const TiPullXmlHandle& ref )   { this->node = ref.node; }

    /// Return a handle to the first child node.
    TiPullXmlHandle FirstChild() const;
    /// Return a handle to the first child node with the given name.
    TiPullXmlHandle FirstChild( const char * value, TiPullXmlNode::NodeType nType ) const;
    /// Return a handle to the first child element.
    TiPullXmlHandle FirstChildElement() const;
    /// Return a handle to the first child element with the given name.
    TiPullXmlHandle FirstChildElement( const char * value ) const;

    /** Return a handle to the "index" child with the given name. 
        The first child is 0, the second 1, etc.
    */
//  TiPullXmlHandle Child( const char* value, int index ) const;
    /** Return a handle to the "index" child. 
        The first child is 0, the second 1, etc.
    */
    TiPullXmlHandle Child( int index ) const;
    /** Return a handle to the "index" child element with the given name. 
        The first child element is 0, the second 1, etc. Note that only TiPullXmlElements
        are indexed: other types are not counted.
    */
    TiPullXmlHandle ChildElement( const char* value, int index ) const;
    /** Return a handle to the "index" child element. 
        The first child element is 0, the second 1, etc. Note that only TiPullXmlElements
        are indexed: other types are not counted.
    */
    TiPullXmlHandle ChildElement( int index ) const;

    #ifdef TIXML_USE_STL
    TiPullXmlHandle FirstChild( const std::string& _value ) const           { return FirstChild( _value.c_str() ); }
    TiPullXmlHandle FirstChildElement( const std::string& _value ) const        { return FirstChildElement( _value.c_str() ); }

    TiPullXmlHandle Child( const std::string& _value, int index ) const         { return Child( _value.c_str(), index ); }
    TiPullXmlHandle ChildElement( const std::string& _value, int index ) const  { return ChildElement( _value.c_str(), index ); }
    #endif

    /// Return the handle as a TiPullXmlNode. This may return null.
    TiPullXmlNode* Node() const         { return node; } 
    /// Return the handle as a TiPullXmlElement. This may return null.
    TiPullXmlElement* Element() const   { return ( ( node && node->ToElement() ) ? node->ToElement() : 0 ); }
    /// Return the handle as a TiPullXmlText. This may return null.
    TiPullXmlText* Text() const         { return ( ( node && node->ToText() ) ? node->ToText() : 0 ); }

private:
    TiPullXmlNode* node;
};

// typedefs back to the old interface class names
typedef TiPullXmlDocument       TiXmlDocument;
typedef TiPullXmlElement        TiXmlElement;
typedef TiPullXmlComment        TiXmlComment;
typedef TiPullXmlUnknown        TiXmlUnknown;
typedef TiPullXmlAttribute      TiXmlAttribute;
typedef TiPullXmlText           TiXmlText;
typedef TiPullXmlDeclaration    TiXmlDeclaration;
typedef TiPullXmlHandle         TiXmlHandle;



#endif // TINYXML_INCLUDED

---